Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Type hinting #127

Merged
merged 16 commits into from
Jan 21, 2025
Merged

Type hinting #127

merged 16 commits into from
Jan 21, 2025

Conversation

mcocdawc
Copy link
Owner

@mcocdawc mcocdawc commented Jan 19, 2025 •
edited
Loading

Part of #124

@mcocdawc
added typing module
06a37e4 
defines Vector, Matrix etc. from numpy
@mcocdawc
Added typing to cartesian core
8b6e8fd 
- added a shared.typing module which defines a couple of helpful types

minor fixes
- got rid of the inheritance from (object), this is redundant since a
  long time
@mcocdawc
added comment
98d617d
@mcocdawc
defined custom njit decorator
9b726e4 
- preserves type-safety

- defaults cache=True
@mcocdawc mcocdawc requested a review from nwhel January 19, 2025 19:52
@codecov Codecov
Copy link

codecov bot commented Jan 19, 2025

Codecov Report

Attention: Patch coverage is 0% with 118 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (651ddc0) to head (991dd23).

Files with missing lines Patch % Lines
...rd/_cartesian_coordinates/_cartesian_class_core.py 0.00% 52 Missing ⚠️
src/chemcoord/_utilities/typing.py 0.00% 18 Missing ⚠️
src/chemcoord/_utilities/_decorators.py 0.00% 14 Missing ⚠️
...oord/_internal_coordinates/_zmat_transformation.py 0.00% 10 Missing ⚠️
...ord/_cartesian_coordinates/_cart_transformation.py 0.00% 7 Missing ⚠️
.../chemcoord/_internal_coordinates/zmat_functions.py 0.00% 4 Missing ⚠️
.../chemcoord/_cartesian_coordinates/xyz_functions.py 0.00% 3 Missing ⚠️
...oord/_cartesian_coordinates/_cartesian_class_io.py 0.00% 2 Missing ⚠️
src/chemcoord/constants.py 0.00% 2 Missing ⚠️
...ian_coordinates/_cartesian_class_pandas_wrapper.py 0.00% 1 Missing ⚠️
... and 5 more
Additional details and impacted files 
@@          Coverage Diff           @@
##           master    #127   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files          29      30    +1     
  Lines        2761    2793   +32     
======================================
- Misses       2761    2793   +32

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nwhel
nwhel approved these changes Jan 21, 2025
View reviewed changes
Copy link
Collaborator

@nwhel nwhel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good to me.

@mcocdawc mcocdawc merged commit cd29f44 into master Jan 21, 2025
6 checks passed
@mcocdawc mcocdawc deleted the type_hinting branch January 21, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nwhel nwhel nwhel approved these changes

Assignees
No one assigned
Labels
enhancement maintenance
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mcocdawc @nwhel